Resource vps

RimuHosting's REST-ful Resources Reference

These APIs are in beta and are subject to change. Please feel free to experiment with them. If you need to rely on them being stable, please contact RimuHosting so we can advise.

These URIs are currently running on https://api.rimuhosting.com. This may change. For example, a sample URL would be https://rimuhosting.com/r/pricing-plans

The most reliable data marshalling media type at this point is application/json. Include 'Accept: application/json' and 'Content-Type: application/json' headers in your requests.

You will need an authorization key to use most of the resources.

For examples and more information see the RimuHosting blog

Path: / r / orders / order-{order-oid}-{domain} / vps

VPS stats (like current kernel name, whether console logins are enabled, whether backups are currently running , when the next backup will run, vps uptime, and VPS seconds used). It also returns host server info. e.g. host load, host cpu information, uptime, xen version, and free (not necessarily the same thing as available!) resource like mem and disk space).

Path parameters:

order-oid ([0-9]+) - The id of the order and a domain name. The domain name is not used in the lookup (we rely solely on the order oid) but the name makes the uri more user-friendly. The order oid is immuatable. It won't change. Even if you rename the server. So it makes a good id.

domain ([^;/]*) - This parameter is ignored. But having it makes the urls a little more recognizable. Typically the VPS domain name is inserted here.

Sub-Resources

Resources
Name	Description
data-transfer-usage	VPS data transfer usage. (Also happens to include a few other VPS stats). The data transfer usage currently takes a few seconds longer than the regular VPS status. So we split this data out so you only take the response time hit when you actually need the information.
host-server	Change a VPS's host server. If the VPS is running it will move the VPS (may result in an IP address change). Moves typically take 5-10 minutes per GB of used file system space on the VPS.
parameters	Change a VPS's resources like memory or disk size. Will force a VPS restart. And will update billing.
reinstall	Reinstall a VPS.
running-state	Change the running state to reboot a VPS. For example, set it to 'RUNNING' if you want to start a stopped VPS (else does nothing). e.g.

Resource Methods

Method Summary
Name	Description
`GET /r/orders/order-{order-oid}-{domain}/vps`	VPS stats (like current kernel name, whether console logins are enabled, whether backups are currently running , when the next backup will run, vps uptime, and VPS seconds used). It also returns host server info. e.g.
`DELETE /r/orders/order-{order-oid}-{domain}/vps`	Do a shutdown and deletion of the server. Cancel the order. Issue a credit for any unused time. We will typically have access to the file system for a 'short' amount of time after the deletion. If you accidentally delete a server, or later change your mind, please contact support as soon as possible and we can often restore it to its original state.

Method Detail

GET /r/orders/order-{order-oid}-{domain}/vps

HTTP Example:: GET /r/orders/order-{order-oid}-{domain}/vps
API Example:: JAXRSVPS.get({'order-oid': /* order_oid The id of the order and a domain name. The domain name is not used in the lookup (we rely solely on the order oid) but the name makes the uri more user-friendly. The order oid is immuatable. It won't change. Even if you rename the server. So it makes a good id. */, 'domain': /* domain This parameter is ignored. But having it makes the urls a little more recognizable. Typically the VPS domain name is inserted here. */});
Output:: GetVPSStatusResponse

DELETE /r/orders/order-{order-oid}-{domain}/vps

Do a shutdown and deletion of the server. Cancel the order. Issue a credit for any unused time. We will typically have access to the file system for a 'short' amount of time after the deletion. If you accidentally delete a server, or later change your mind, please contact support as soon as possible and we can often restore it to its original state.

HTTP Example:: DELETE /r/orders/order-{order-oid}-{domain}/vps
API Example:: JAXRSVPS.delete({'order-oid': /* order_oid The id of the order and a domain name. The domain name is not used in the lookup (we rely solely on the order oid) but the name makes the uri more user-friendly. The order oid is immuatable. It won't change. Even if you rename the server. So it makes a good id. */, 'domain': /* domain This parameter is ignored. But having it makes the urls a little more recognizable. Typically the VPS domain name is inserted here. */});
Output:: DeleteServerResponse